AVEVA™ InTouch HMI, formerly Wonderware
Version 2020 R2 Readme

Last revision: 12/4/2020

In This Document

About This Readme

New Features

System Requirements

InTouch HMI 2020 R2 Product Compatibility

InTouch HMI Installation

Resolved Issues

Known Issues

InTouch HMI Documentation Issues

InTouch Documentation

About This Readme

This Readme provides information about InTouch HMI 2020 R2 (Version 20.1.000). Readme files from previous releases of InTouch HMI are posted on the Support website.

Important!

When installing System Platform 2020 R2, Operations Integration (OI) Gateway is installed as a hidden feature of InTouch HMI 2020 R2.

For more information about OI Gateway installation, upgrade, and uninstall, see the System Platform Installation Guide, "InTouch HMI Requirements and Prerequisites" section, "Installing OI Gateway and Modifying FS Gateway Installations" topic.

Related Topics

AVEVA™ InTouch HMI 2020 R2 Readme

New Features

System Requirements

InTouch HMI 2020 R2 Product Compatibility

InTouch HMI Installation

Resolved Issues

Known Issues

InTouch HMI Documentation Issues

InTouch Documentation

Important Information for Microsoft Windows Server 2016 Users

Remote Desktop Services and InTouch HMI

When InTouch HMI 2020 R2 is installed on an older Windows 10 or Windows Server 2016 computer that has not been updated and has Remote Desktop Services enabled, WindowViewer may fail to launch. WindowMaker cannot be closed unless shut down using Task Manager.

Workaround:

  1. Download and install either of the following Microsoft Windows updates:
  2. After installation of the update is complete, restart the system and install System Platform 2020 R2.

    Important: You can install the Microsoft update before or after System Platform. However, we recommend installing the Microsoft update before you install System Platform.

How to Find the Latest Product Requirements and Compatibility Information

For important information about this product release, go to the AVEVA Global Customer Support (GCS) website. Information on the GCS website includes product requirements, compatibility, as well as downloads from previous releases. After you log in, you can filter search results by product name and the release/version.

New Features

InTouch HMI 2020 R2 (Version 20.1.000) includes a number of new features, hot fixes, and provides support for the latest versions of Microsoft products. Refer to the GCS Technology Matrix for the list of supported Microsoft products. The following section summarizes the major features introduced in this release.

Integration with AVEVA Connect

Enhancements and improvements in security and performance to the integration with AVEVA Connect.

Web Widgets

This release introduces two new web widgets; QR Code Scanner and Web Browser.

InTouch HMI as an OPC UA Server

InTouch HMI can now function as a secure OPC UA Server allowing OPC UA clients to connect to it.

Web Client Configuration Tab in Application Manager

Web Client settings can now be configured via the new Web Client tab in InTouch HMI Application Manager

Using InTouch HMI applications in AVEVA Edge

InTouch applications can be packaged and deployed to AVEVA Edge devices. This helps reuse existing InTouch applications with Industrial Graphics and also enables access to the Web Client.

Other Important Features

Web Client

The following enhancements and improvements were made to the Web Client this release:

System Requirements

This section describes the hardware and software requirements to support System Platform products, including InTouch HMI.

Hardware Requirements

System Sizing Guidelines

The following table provides guidelines for hardware configurations suitable for System Platform 2020 R2 software based on the size of the installation. These guidelines are subject to the limitations of your Windows operating system.

Hardware Requirement

Small Installation (1 - 25K I/O per Node)

Medium Installation (25k - 50k I/O per Node)

Large Installation (More than 50k I/O per Node)

CPU Cores (Minimum)1

Greater than or equal to 2

Greater than or equal to 4

Greater than or equal to 8

RAM1 (GB)

Greater than or equal to 4

Greater than or equal to 8

Greater than or equal to 16

Storage (GB) 2

Greater than or equal to 100

Greater than or equal to 500

Greater than or equal to 1000

Network (Mbps)

Greater than or equal to 100

Greater than or equal to 1000

Greater than or equal to 1000

Notes:

1 In redundant environments, increase CPU and RAM to maintain a maximum of 40% typical resource utilization.

2 Minimum amount of storage needed to provide sufficient capacity for 1 week @ max frequency.

Hardware Requirements Notes

Windows operating systems and SQL Server versions may impose hardware requirements that exceed the minimum requirements for InTouch HMI 2020 R2. Refer to the following Microsoft Web pages for Windows and SQL Server hardware requirements:

Auxiliary Hardware Requirements

This section describes any optional hardware requirements beyond the specific hardware requirements discussed earlier in this Readme.

Alternative Authentication Using Smart Cards

Operating System, .NET Framework, and Virtualization Requirements

This section describes additional details about the supporting software for an InTouch HMI system.

Software Requirement Notes

Windows Operating System Notes

.Net Notes

Operating System Notes Common to AVEVA Products

ActiveX Controls Behavior on Supported Windows Operating Systems

Due to the Data Execution Prevention (DEP) feature of Windows 7 and later operating systems, any ActiveX control built with ATL version 7.1 or earlier will fail to host or will have unpredictable behavior in InTouch 2017 UPDATE 1 either in WindowMaker or WindowViewer. For more information, refer to Tech Note 922: "Some ActiveX Controls NOT Supported in InTouch 2012 R2 (Version 10.6)" available from the Technical Support web site.

Configuring Remote Alarm Retrieval Queries

The process to configure remote alarm retrieval queries has changed for interactive applications such as InTouch HMI when running on currently-supported Windows and Windows Server operating systems.

When InTouch WindowViewer is started and generates alarms from an interactive Windows desktop session, an AlarmViewer control (running within InTouch HMI) on a remote node must be specially configured to query the alarms. The source alarms will not appear unless the AlarmViewer control's alarm query is configured.

This type of query only works for InTouch HMI as an alarm provider running in a Terminal Services session, not for InTouch HMI running in a console session.

To configure the AlarmViewer's alarm query

  1. After starting InTouch WindowViewer (alarm provider), open the SMC Logger and look for the most recent string generated by AlarmMgr. For example: "Registering AlarmMgr with SLSSVC as AlarmMgr 253.127.148.120". The indicated IP address will be unique to your alarm-providing node. Note the IP address for Step 2.
  2. In the Alarm Query tab of the AlarmViewer control on the remote computer, configure the alarm query as follows, substituting your nodename of the alarm providing InTouch HMI for "nodename" below and substituting your IP address noted in the previous step:

    \\nodename:ip_address\intouch!$system

    where nodename is the name of the node that is providing the InTouch alarm and ip_address is the IP address that you determined in step 1.

  3. Test to validate that the alarms generated from the alarm-providing node are shown accurately in the AlarmViewer control.

Using Alarm Manager on a Single Node Running Both InTouch HMI and Application Server Alarm Providers

Starting with Microsoft Windows Vista, the operating system imposes "Session 0 Isolation" as a security enhancement. All Windows services and associated programs are required to run in Session 0, and no GUI applications are allowed to run in Session 0.

Prior to Windows Vista, Application Server and InTouch HMI WindowViewer ran in the same Windows session. Session 0 Isolation requires that Application Server and WindowViewer run in separate Windows sessions. Alarms that are reported by the Galaxy are handled by the Session 0 instance of Alarm Manager (AlarmMgr), which is now different from the Console Session instance of AlarmMgr that handles InTouch alarms. A simple alarm query in an InTouch alarm display such as

\InTouch!$System \Galaxy!Area_001

is now serviced by two separate instances of AlarmMgr -- one running in the Console Session for InTouch, another running in Session 0 for the Galaxy.

This behavior, and related behaviors and error messages resulting from the Windows operating system Session 0 changes, along with procedures to configure the Distributed Alarm System to support alarms from both InTouch and Application Server on the same computer node running with Windows Vista and later operating systems, are described in detail in TechNote 988, "AlarmMgr Support for InTouch and AppServer on Windows Vista and Later". You can download this TechNote from the Global Customer Support (GCS) website.

Remote Desktop Services (Terminal Services) Behavior in Windows Server Operating Systems

Windows Server 2008 R2 and later Windows versions no longer support the /console switch as a means of starting the remote desktop (RDP) client, also known as Session 0 or Terminal Server Console session. In Windows Server 2008 or later, Session 0 is no longer an interactive session, and is reserved only for Windows services. From Windows Server 2008 and later, all remote connections are treated as remote RDP sessions regardless of /console, /admin, or any other switches used to make the connection.

This impacts InTouch HMI functionality such as Alarm Manager that depends on the Remote Desktop (Terminal Server Console) session.

In another aspect of Remote Desktop Services behavior, InTouch HMI functions such as TSEGetClientID() can return a null value with InTouch running in a remote desktop (RDP) client session. The cause of this behavior is that the relevant roles are not installed on the RDP client. You must install the "Remote Desktop Host" role in order for TSEGetClientId() and other related functions to work properly.

The impact to Application Server is minimal as most Application Server processes run as services. One impact to Application Server is to carry forward the restriction introduced with the Windows Vista operating system which permits only one alarm provider. While both Application Server and InTouch HMI can be configured as alarm providers, only one alarm provider can be configured at any one time.

Application Server and InTouch HMI detect when the application is running in the console. In Windows Server, it implies that the application was started by a user physically at the machine. However, this behavior may require you to disable the group policy that enables Fast User Switching.

The software detects when an application is running in the console. All remote connections are treated as a remote RDP session by Windows Server, regardless of /console or /admin switches in the mstsc connection.

To disable fast user switching through the Group Policy interface

  1. Click Start and then Run. The Run dialog box appears.
  2. Enter gpedit.msc and click OK. The Group Policy dialog box appears.
  3. Go to the following location: Local Computer Policy > Administrative Templates > System > Logon.
  4. Set Hide Entry Points for Fast User Switching to Enabled. Enabling this policy hides the Switch User option in the Logon interface, the Start menu, and the Task Manager.
  5. On the File menu, click Exit to close the Group Policy dialog box.

By enabling the policy, Administrators hide the Switch User button in Windows logon, in the Start menu, and in the Task Manager.

InTouch HMI Operating System Notes

InTouch HMI View Applications and DDE Support

NetDDE is not supported for InTouchView applications.

By design, an InTouchView application does not serve data to any other source, including InTouch HMI itself. When WindowViewer starts, it verifies if the application is an InTouchView application. When WindowViewer detects an InTouchView application, it does not register to become a DDE server. Industrial Graphics make use of the client layer when accessing InTouch tags, and appear as a third-party client trying to access WindowViewer as a data server. As a result, Industrial Graphics cannot communicate with InTouch tags when used with an InTouchView license.

In Industrial Graphics, InTouch:‹tagname› is still a valid method of referring to an InTouch tag on a local node.

InTouch HMI Support for Windows User Account Control

System Platform 2020 R2 with InTouch HMI supports User Account Control-enabled operations on run-time nodes.

.NET Framework Requirements and Compatibility

IMPORTANT: System Platform 2020 R2 installs .NET 4.8 if the currently installed version of .NET is 4.7.2 or lower. If .NET 4.8 or later is installed, no change is made to the .NET Framework. Prior to upgrading your existing applications to System Platform 2020 R2, we strongly recommended that you:

After upgrading to System Platform 2020 R2, you should perform application testing on application scripts and on script libraries used by the application to ensure they continue to function properly under .NET 4.8. We also recommend you test the upgrade in a staging system prior to upgrading your production system.

System Platform 2020 R2 leverages Microsoft .NET Framework 4. The System Platform installation program will install .NET 4.8 if your system uses version 4.7.2 or lower. No change is made if your system uses .NET 4.8 or higher. Multiple versions of the .NET Framework can coexist. On nodes where SQL Server is installed, .NET 3.5 is also installed by System Platform to support SQL Server. In this scenario, other applications you have on the same machine with dependencies on .NET 3.5 will access .NET 3.5. System Platform 2020 R2 will use .NET 4.7.1, 4.7.2, or later.

All user-supplied .NET code that runs in the context of InTouch HMI and Application Server requires .NET Framework 4.8 or higher. Although .NET Framework 4.5.1 (and later) is highly compatible with applications that are built with earlier .NET Framework versions, you may have to update your scripts, if your .NET scripts were created prior to System Platform 2014. These changes may also affect .NET controls developed with .NET 3.5.

In application scripting, some .Net codes could fail if not using proper text encoding, and could cause a script to exit without completion. The UTF8Encoder is the default BinaryStream decoder in .Net 4.5. To enable an application script to decode ASCII XML data, for example, insert the following snippet:

BinaryReader streamReader = new BinaryReader(ms, new ASCIIEncoding());

To learn more about changes introduced in different versions of the .NET Framework, refer to the following Microsoft resources:

What's New in the .NET Framework: http://msdn.microsoft.com/en-us/library/ms171868%28v=vs.110%29.aspx

What's obsolete in the .NET Framework Class Library: https://msdn.microsoft.com/en-us/library/ee461502%28v=vs.110%29.aspx

Migration Guide to the .NET Framework 4.6 and 4.5: https://msdn.microsoft.com/en-us/library/ff657133%28v=vs.110%29

.NET Framework 4 Migration Issues: http://msdn.microsoft.com/en-us/library/ee941656%28v=vs.100%29

Virtualization Host Support

See the Global Customer Support (GCS) Technology Matrix for supported virtualization environments.

Related Topics

System Requirements

Hardware Requirements

SQL Server Requirements

InTouch Access Anywhere Requirements

SQL Server Requirements

SQL Server Requirements for All Components

See the GCS Technology Matrix for SQL Server requirements for System Platform 2020 R2 components, including InTouch HMI 2020 R2.

Note: Match SQL Server version to operating system version.

We recommend that you install and configure the supported SQL Server version before you begin the System Platform installation program, especially if you expect Information Server to coexist, either on initial or subsequent installations, with the InTouch HMI, Application Server, or the Historian Server.

The System Platform installer will install all prerequisites except the SQL Server requirement for installing the Historian Server. If you select the Historian Server for installation, and if the supported version of SQL Server is not already installed, you must exit the installation program, install the supported SQL Server version, and then resume the installation.

Considerations for SQL Server

If you accidentally delete the aaAdministrators group from the SQL Server security logins, you must run the aaConfig SQL Utility to restore it. Refer to the Application Server User's Guide, About ArchestrA User Accounts, for further information and procedures to restore the aaAdministrators group.

Considerations for SQL Server Express

Related Topics

System Requirements

Hardware Requirements

Operating System, .NET Framework, and Virtualization Requirements

InTouch Access Anywhere Requirements

InTouch Access Anywhere Requirements

The following sections describe the requirements to run InTouch Access Anywhere Server and supported browsers. For detailed information, see the InTouch Access Anywhere documentation.

You can determine the version of InTouch Access Anywhere Server installed on a computer using Programs and Features from the Windows Control Panel.

Requirements

The InTouch Access Anywhere Server can be installed as a System Platform installation option. The InTouch Access Anywhere Secure Gateway is an optional component installed on a separate computer within a network DMZ.

The following requirements must be met before you install the InTouch Access Anywhere Server or a Secure Gateway.

Supported InTouch Access Anywhere Browsers

InTouch Access Anywhere can run on smart phones, tablets, laptop computers, or any other device that supports an HTML5-compliant web browser. Browsers validated to support InTouch Access Anywhere include the following:

Functionally Compatible Browsers

Older versions of the listed browsers are functionally compatible with InTouch Access Anywhere. You may be able to use the following older versions of these browsers, but specific behaviors are unknown because no formal testing has been done with InTouch Access Anywhere.

You are strongly encouraged to upgrade to one of the supported browser versions listed in Browsers Tested with WindowViewer. For a complete list of considerations to run an InTouch application with InTouch Access Anywhere on a portable device, see the InTouch Access Anywhere User Guide.

Related Topics

System Requirements

Hardware Requirements

Operating System, .NET Framework, and Virtualization Requirements

SQL Server Requirements

InTouch HMI 2020 R2 Product Compatibility

Product Compatibility refers to the ability of a product to work with various versions of other products running on different network nodes. Product Compatibility also refers to the ability of a product to work with various versions of the same product running on different nodes.

Coexistence refers to same-node installation of a product with other products that support the same hardware, operating system, and SQL Server versions. Other products not listed will be covered by System Compatibility Testing unless specifically noted.

In a single-node environment, if you want to install multiple components on a single computer, all components must be at the same versions.

In a node-to-node environment, components are compatible between the current licensed version and one licensed version back. Refer to the GCS Technology Matrix for more information.

The following table lists products and their compatibility and coexistence with InTouch HMI 2020 R2.

Product

Version

Compatibility

Co-existence

System Platform

4.5

N

N

2012

Y

N

2012 R2

Y

N

2012 R2 P01

Y

N

2012 R2 P02

Y

N

2012 R2 P03

Y

N

2014

Y

N

2014 P01

Y

N

2014 R2

Y

N

2014 R2 P01

Y

N

2014 R2 SP1

Y

N

2017

Y

N

2017 Update 1

Y

N

2017 Update 2

Y

N

2017 Update 3

Y

N

2017 Update 3 SP1

Y

N

2017 Update 3 SP1 P01

Y

N

2020

Y

N/A

Manufacturing Execution System

 

MES 2017 R2

Y

Y

MES 200

Y

Y

InTouch CE

10.1

N

N

InControl

7.11 SP2 P01

N

N

Batch Management

2020

Y

Y

QI Analyst

8.0 SP4

Y

Y

SCADAlarm

6.0 SP2 P01

N

N

Intelligence

2014 R3

Y

N

2017 U1

Y

Y

Workflow Management

2020

Y

Y

Mobile Operator Rounds

5.01

Y

Y

2014 R2

Y

Y

Insight (see components below)

1.0

 

 

Insight Client (On-Prem)

17.x (via Historian)

Y

N

Historian Client

10.x/17.x

Y

N

InTouch

11.x

Y

N

Recipe Management

2020

Y

Y

PlantSCADA

2016

Y

Y

2018

Y

Y

2018 R2

Y

Y

ClearSCADA

CS 2017 R1

Y

Y

CS 2017 R2

Y

Y

CS 2017 R3

Y

Y

GS 2019

Y

Y

AVEVA System Monitor

 

1.1

Y

Y

1.2

Y

Y

Sentinel Agent

1.0

N/A

Y

Sentinel Server

1.0

N/A

N

ASB (now PCS)

 

SP 2012 R2 SP1

N

N

SP 2014 R2 SP1 P01

Y

Y

SP 2017

Y

Y

SP 2017 U1

Y

Y

SP 2017 U2

Y

Y

PCS and SMS

 

SP 2017 U3

Y

Y

SP 2017 U3 SP1

Y

Y

SP 2020

Y

Y

Supported

Y

Not Supported

N

Not Applicable

N/A

In some cases, InTouch HMI is supported in newer environments than a compatible product. InTouch HMI has been tested for compatibility with a listed product only in the environments that are supported by that particular product.

Related Topics

AVEVA™ InTouch HMI 2020 R2 Readme

About This Readme

New Features

System Requirements

InTouch HMI Installation

Resolved Issues

Known Issues

InTouch HMI Documentation Issues

InTouch Documentation

InTouch HMI Installation

For detailed English installation instructions, see the System Platform Installation Guide (SP_Install_Guide.pdf) or System Platform Installation Help (SP_Install_Guide.chm). Condensed English installation instructions are also provided in the printed InTouch HMI Getting Started Guide booklet that is included in the installation package. This booklet is provided for all supported languages.

The information provided in this Readme file supersedes the InTouch Installation Help (Install-InTouch.chm) for the French, German, Japanese, and Simplified Chinese languages.

Installing InTouch HMI

The major decision you must make when you install InTouch HMI is whether to install the InTouch development and run-time components, or the run-time components alone. The installation program guides you in selecting the features you want, verifying or modifying your selections, installing prerequisite software, and then installing InTouch HMI and the IDE if you chose to install development components.

What You Need to Install InTouch HMI

You must have the following materials ready to install InTouch HMI:

Prerequisites

The installation program analyzes the software installed on your computer and lists any required software that is not installed.

Note: At the start of the installation, the prerequisites check is system-specific rather than product-specific.

The following prerequisites, if not already present on your system, will be installed by the System Platform installation program:

The installation program installs both system-specific and product-specific prerequisites. You do not have to exit from the installation program to install the prerequisite software. For more information about System Platform installation prerequisites, see the System Platform Installation Guide.

About the ArchestrA User Account

The ArchestrA user account is a user name and password combination that enables inter-node communication between all computers in an Application environment. You must specify the same user account on every node when you install the System Platform components for the first time on computers that communicate with each other.

WARNING! The ArchestrA user account is a Windows operating system account located on the local computer or on a domain. Do not delete this account with operating system account management tools. If you do, ArchestrA-enabled software may stop functioning properly.

If the ArchestrA user account has not previously been configured, you will be prompted to configure it during the InTouch HMI installation. You must specify a user name, password, and domain.

If you choose to use an existing user account, it should meet the following requirements:

After you install the InTouch HMI, you can use the ArchestrA Change Network Account utility to change or recreate the ArchestrA user account. This utility is accessible from the Start menu in the AVEVA Common folder after you install InTouch. You must have Administrator privileges on the computer to make changes with the Change Network Account utility. For more information, see the Change Network Account utility help.

Note: If you recreate the user account using the Change Network Account utility, the Microsoft Windows security component on the computer can take several minutes to update this information on the ArchestrA Galaxy node. Until that occurs, the ArchestrA component may not function properly. Restarting the Galaxy node updates this information immediately.

Performing the InTouch HMI Installation

Before you start installing InTouch HMI, you should have a clear idea whether you want to develop, deploy, and publish your own applications, or require only the InTouch run time, to run applications already created and deployed.

The following procedure will guide you through the installation, with information specific to the InTouch HMI.

To install the InTouch HMI

  1. Insert the installation DVD into the computer's DVD drive.
  2. Using Windows Explorer, manually start the installation by double-clicking setup.exe on the DVD.
  3. Follow the prompts to start the installation and install system prerequisites, as necessary.

    The installation program prompts you to select an installation type: either product-based selection or installation by computer roles. As you are only installing InTouch HMI, click the product-based selection as your installation type.

  4. Choose the components you want to install.
    1. If you choose InTouch Run Time Only, the following will be installed:
      • InTouch Run Time
      • InTouch documentation
      • Alarm DB Logger
      • OI Gateway (as a silent installation)
      • Application Server Bootstrap
      • InTouch Supplemental Components: InTouch Recipe Manager, InTouch SQL Access, and Symbol Factory

      Note: The 16 Pen Trend supplementary component is not installed by default. You must select the Customize Installation option and select 16 Pen Trend from the product list to install it as part of the InTouch HMI installation procedure.

      • AVEVA Enterprise Licensing Platform
      • InTouch Web Client
      • AVEVA System Monitor - Sentinel Agent
      • ASB Runtime Components
    2. If you choose InTouch Development and Run Time, the following will be installed:
      • All items listed under step a in these instructions.
      • InTouch Development
      • ASB Service Repository
      • InTouch demo applications
  5. When the installation prompts you to verify your selection, select Customize Installation if you want to add or remove components of your InTouch installation.
  6. After you verify and customize your selection, you are prompted to select the language you want to install. English is selected by default, but you can choose another supported language from the list.
  7. Follow the subsequent installation steps to:
    1. Accept the End User License Agreement.
    2. Create a new ArchestrA user account, or specify an existing account.
    3. Install any prerequisite software components not yet installed on the computer.
    4. The installation proceeds to completion. You must restart the computer after completing the installation.

Activating Your InTouch License

InTouch uses the AVEVA Enterprise License Server to make licenses available. The AVEVA Enterprise License Manager manages one or more License Servers.

You use the AVEVA Enterprise License Manager interface to make licenses available to InTouch. First, import the entitlement XML file received upon purchase of the license. Then, select which licenses on the entitlement to activate on the License Server. After activation, the license becomes available to WindowMaker or WindowViewer upon start up. The license is released when InTouch is shut down.

InTouch will run in Demo Mode if it cannot consume a valid license at start up time.

To install AVEVA Enterprise licensing, see the AVEVA Enterprise Licensing Guide.

Antivirus Software Exclusions

Antivirus software should be implemented as part of a defense-in-depth strategy to secure your industrial control systems.

Visit https://softwaresupport.aveva.com/ to get the latest information on antivirus software recommendations.

Modifying, Repairing, or Removing the InTouch HMI

To modify, repair, or remove a product

  1. Insert the installation DVD into the computer's DVD drive.
  2. Access the Windows Control Panel and select the Programs and Features option. The list of software installed on your computer appears.
  3. Select the InTouch component, and then click the Uninstall/Change button. The Modify, Repair or Remove Installation dialog box appears.
  4. Follow the prompts to modify, repair, or remove InTouch. The name of the Uninstall/Change button varies depending on the version of Windows installed on your computer.

    Note: Modern applications can no longer be created, edited, or run after Application Server is uninstalled from the same computer that also hosts InTouch run time and development components. Modern applications no longer work because the Galaxy Repository required for Modern applications is removed when Application Server is uninstalled.

Upgrading to the Latest Version from an Earlier Version of InTouch HMI

Upgrading refers to installation on a computer that already has a previous version. An upgrade removes the previous version of InTouch HMI and installs the latest version.

After the hardware and software requirements are met, you can upgrade to the latest version of InTouch HMI from the following versions of the InTouch HMI:

You can only upgrade System Platform products that are already installed. You cannot install any new System Platform products by an upgrade process.

To upgrade from a previous version of the InTouch HMI

  1. Insert the DVD into your DVD-ROM drive. Run setup.exe to start the set-up program. The upgrade feature dialog box appears.
  2. Follow the prompts to complete the upgrade.

Upgrade Notes

Migrating Applications to InTouch HMI 2020

Migration converts applications created with earlier versions of InTouch HMI to the current version. You can migrate applications to InTouch HMI 2020 R2 that were developed with earlier versions of InTouch HMI as shown in the following table:

From

Upgrade

Node-by-Node Upgrade

Migrate

7.0

N

N/A

N

7.1

N

N/A

N

7.11 P07

N

N/A

Y

8.0 SP2 P04

N

N/A

Y

9.0 P03

N

N/A

Y

9.5 SP1

N

N/A

Y

10.0 SP2

N

N/A

Y

10.1 (no SP)

N

N/A

Y

10.1 SP2

N

N/A

Y

10.1 SP2 P01

N

N/A

Y

10.1 SP3

N

N/A

Y

10.1 SP3 P01

N

N/A

Y

11.1 SP1

Y

Y

Y

11.1 SP1 P02

Y

Y

Y

17.0

Y

Y

Y

17.1

Y

Y

Y

17.2

Y

Y

Y

17.3

Y

Y

Y

17.3.1

Y

Y

Y

17.3.101

Y

Y

Y

20.0.000

Y

Y

Y

Note: For InTouch Version 10.2 and newer, refer to the System Platform migration table. InTouch cannot be installed or upgraded as a single product since Version 10.2. Therefore all installed products on a node must be upgraded at the same time.

SPCPro was a Statistical Process Control (SPC) utility available with InTouch HMI prior to Version 11.0. SPCPro is no longer supported by InTouch HMI. We recommend that that you migrate your SPCPro databases to the latest version of QI Analyst if you still use SPCPro with InTouch. QI Analyst provides support for the latest versions of operating systems and databases.

QI Analyst also includes a utility to migrate your SPCPro database to a QI Analyst database, leaving the existing SPCPro database intact. Please contact your local sales representative for further information.

Important Note: We strongly recommend that you migrate your current SPCPro databases to QI Analyst before installing System Platform Version 20.0.000 with InTouch HMI. InTouch no longer includes SPCPro and will not open or migrate applications containing SPCPro components.

Resolved Issues

InTouch HMI 2020 R2 includes corrections for the issues listed in the following table. These issues are listed by their Defect ID (CR, TFS or IMS) number, any assigned Service Request (SR) or Case Number with a brief description of the defect.

Defect ID

SR/Case Number

Description

CR-L00154610

CR-L00154730

SR-198110066

The Alarm Control Client stopped worked intermittently and did not display alarms.

CR-L00155025

CR-L00156397

SR-103166766

The XML Import resulted in an error; "XML Schema Validation Failed: The 'IsReplace' attribute is not declared." when the ShowSymbol animation was used.

CR-L00155304

CR-L00155356

SR-63212306

Users could not move to the next page in the alarm control when the scrollbar was clicked at the bottom of the list.

CR-L00155929

CR-L00156602

SR-54810951

When an InTouch application was deployed to multiple nodes, not all files were delivered successfully, causing the application to not work as expected.

CR-L00156519

CR-L00156850

SR-47410921

The $InactivityTimeout and $InactivityWarning system tags id not reset when interacting a graphic launched from another graphic.

CR-L00156545

CR-L00156603

SR-103164853

The application did not open in WindowViewer and reported an error 'Exception caught for ViewInitialize' in the SMC.

CR-L00156735

CR-L00156989

SR-63511127

The SQLSelect() function truncated long bind lists.

CR-L00156771

CR-L00156962

SR-103167125

When an InTouch tag with a value of 7 digits is displayed within an Industrial Graphic, the value was rounded over.

CR-L00156924

CR-L00157025

SR-103167229

For a Japanese application, when the font was set to System and bold, the PrintWindow() function did not work as expected.

CR-L00156975

CR-L00157038

SR-103166707

The $InactivityWarning Tag did not stay true when triggering a Show() script Function while hovering over a frame window.

CR-L00157136

CR-L00157218

SR-103168335

The key-down script did not work as expected for a frame window.

CR-L00157224

CR-L00157268

SR-103166728

In a Chinese InTouch application, when the Area name was longer than 21 characters, the application closed unexpectedly.

CR-L00157317

CR-L00157469

SR-78610049

Alarm Manager performance was not as expected resulting in slower alarm acknowledgements.

CR-L00157505

CR-L00158357

SR-49911269

A Win911 application using the Alarm toolkit with long galaxy area names stopped working unexpectedly.

CR-L00157535

CR-L00157769

SR-75110694

The deployment of an InTouch application took longer than expected.

CR-L00157558

CR-L00157888

SR-54411891

No Alarms were displayed in the Alarm Client Control if the Alarm Query was built using an Object Reference.

CR-L00157594

CR-L00157751

SR-81810685

The order of the custom properties differed between two versions of InTouch.

CR-L00157677

CR-L00157887

SR-41810670

The InTouch Print function did not print correctly, if the tagname contained a "%".

CR-L00157971

CR-L00158109

SR-63810167

When an alarm was shelved, the operator column did not reflect the name of the Operator.

CR-L00158127

CR-L00158370

SR-103171182

Users were unable to select multiple elements in the Alarm Tree Control using the Ctrl + Shift keys.

CR-L00158150

CR-L00158289

SR-103171040

Passwords typed using the Windows / Resizable Keyboards were not hidden on the screen.

CR-L00158395

CR-L00158780

SR-103171569

The Alarm Manager did not retrieve the results of a query within an acceptable time, when a non default port was set, with no other protocol than TCP/IP.

CR-L00158464

CR-L00159549

SR-57211787

The memory usage of the Alarm Manager increased over time.

CR-L00158496

CR-L00160108

SR-51316492

On occasion, the Trend Client Control displayed incorrect values and did not render the trend correctly.

CR-L00158585

CR-L00158668

SR-103169271

The Alarm Client Control did not work for history blocks when using the Like operator and caused an error when WindowMaker was launched from the IDE.

CR-L00158726

CR-L00158841

SR-22210592

In the web client, when one frame window was used to display multiple industrial graphics, the graphics did not display as expected.

CR-L00158746

CR-L00158813

SR-103170563

After the operating system language was changed from English to Russian, and an InTouch modern application was imported, it could be edited once.

CR-L00158787

CR-L00159256

SR-103170884

The Alarm Client Control could not retrieve alarms from History Blocks and displayed a "Not connected" status.

CR-L00158820

CR-L00158878

SR-103172089

For a particular scenario in the Alarm Client Control, the Value and Limit columns appeared as options under the Sort operation.

CR-L00158931

CR-L00159017

SR-103172462

NewAlarm event does not work in InTouch 2017 U3 SP1 P01 and InTouch 2020 as expected.

CR-L00159113

CR-L00159468

SR-48913032

The WWALMDB database continued to have the old views after migration to InTouch 2017 U3 SP1.

CR-L00159141

CR-L00159257

SR-103172824

The user could not delete a tag even when it was not used.

CR-L00159145

CR-L00159978

SR-73610236

WindowViewer did not automatically acquire the license at start up.

CR-L00159161

CR-L00159632

SR-103173182

After migrating to InTouch 2017 U3 SP1 and importing translated text the font properties were not applied in runtime.

CR-L00159211

CR-L00159285

SR-10317229

In a specific scenario of a Frame window, using ShowSymbol to open a Modal dialog and from there using ShowGraphic to show a Modal dialog. When the user pressed the ESC key continuously for two times, WindowViewer closed unexpectedly.

CR-L00159219

CR-L00159286

SR-41810708

The "Allow WindowViewer to dynamically change resolution" selection in the "Node Properties" screen was not saved.

CR-L00159229

CR-L00159327

SR-103172849

The Web Client did not display the graphics for an application.

CR-L00159389

CR-L00159585

SR-48310260

An unused tag could not be deleted.

CR-L00159454

CR-L00159749

N/A

When exporting Window and Graphic of a frame window and importing to new application, the window contained the wrong Industrial Graphic.

CR-L00159542

CR-L00159638

SR-103173005

In the Trend Client Control, the Time Stamp was not updated when the DurationMS property was updated.

CR-L00159572

CR-L00159728

SR-41810713

A script function displayed the red underline when special characters were used in function names.

CR-L00159667

CR-L00159729

SR-103173806

Filtering alarms in the Alarm Client Control did not display any records.

CR-L00159800

CR-L00159941

SR-103173001

The values of Trend Client Control did not match when the pen reference values were changed dynamically using scripts.

CR-L00159839

CR-L00160020

SR-47710057

 

On occasion, additional graphics are displayed when just one graphic was selected to be displayed.

CR-L00159906

CR-L00160018

SR-84610999

The Alarm Client Control could not retrieve alarms from History Blocks.

CR-L00159925

CR-L00159968

SR-103172612

The Trend Client Control performed slower after migration to InTouch 2017 Update 3 SP1.

CR-L00157497

SR-51316628

The Alarm Client Control did not sort records for the column TimeLCTOAT correctly.

CR-L00157673

SR-51514298

When the same name was used for TextBox in a graphic and an embedded graphic it resulted in an error.

CR-L00158096

N/A

On a node, where only InTouch WindowViewer was installed, launch InTouch Application Manager caused a .NET unhandled exception.

CR-L00159134

SR-41810710

The menu text was not correctly translated in Japanese.

CR-L00159470

SR-402110877

In the Alarm Client Control, when scripting the modes between Current Alarms (AlarmClient.AlarmMode=1) and Historical Alarms, such AlarmClient.AlarmMode=5, did not work as expected.

CR-L00159593

SR-244144424

Users were unable to drag a graphic to the top most level in the graphic toolbox of a Modern app.

CR-L00159754

SR-103174748

The $HistoricalLogging tag did not work when 'Enable Storage to Historian' was set for 'Enable Historical Logging'.

CR-L00160070

CR-L00160082

SR-103174185

Opening frame windows multiple times over a period of time, caused the WindowViewer to slow down and exceed memory usage.

IMS-513939

IMS-960002003

Running a NAD application required the credentials of a power user.

IMS-546134

IMS-960005625

Embedded graphics were not displayed in the web client and an error message was logged in the SMC

IMS-550883

IMS-0002097204

When using the Alarm Client Control, a warning message "Open() of DCMConnection failed: 'Cannot open database Runtime' Login Failed" was displayed in the SMC, although the Historian was not installed or used.

IMS-562166

IMS-960009845

InTouch windows did not allow the special character period (.) in the window name.

IMS-563883

IMS-0001503678

On occasion, an error was noticed when the memory pointer was null.

IMS-564241

IMS-960008713

Using the AddPen() method with GetPenValAtX1(2) in scripts threw a warning message “Input string was not in a correct format”.

IMS-564848

IMS-960010221

Industrial graphics were not displayed, when NAD was enabled and the application was available on a shared drive on a different node.

IMS-567362

IMS-960012068

In the cross reference window, using drag and drop to select a column header for the Group By section caused an error.

IMS-551648

IMS-0001869827

Web Client did not display InTouch tag values when WindowViewer acquired an InTouch HMI Read-Only license.

Known Issues

This section describes known issues that remain in the release of InTouch HMI 2020 R2.

Defect ID

Description

TFS-1351507

Language switching is not supported for the Carousel Widget in runtime.

TFS-1369183

A Carousel Widget containing the Web Browser Widget, QR Code Scanner Widget, Trend Client Control, Alarm Client Control or SQL Data Grid Control will not display correctly in WindowViewer, as default browser security options prevent cross-origin requests.

TFS-1372178

Carousel widgets in a managed application migrated from InTouch 2020 to InTouch 2020 R2, do not contain the latest properties.

Workaround: On migrating a Galaxy from InTouch 2020 to InTouch 2020 R2, run the IDE as an Administrator atleast once, to allow loading the latest InTouch 2020 R2 carousel widget properties.

TFS-1371799

When an InTouch 2020 application (.aapkg) is exported and imported to InTouch 2020 R2, then the default namespace for a tag reference within a Carousel widget is not resolved in runtime.

Workaround: Open the graphic containing the Carousel widget. Edit any property and save the graphic. The tag reference is resolved, and the graphic is displayed in runtime.

TFS-1374896

After a graphic/toolset is created, the letter case of the graphic name cannot be changed in WindowMaker. For example: INTOUCH cannot be changed to InTouch.

Workaround: Rename the graphic to a temporary name. Rename the graphic again with the correct letter case. For example: Rename INTOUCH to ChangeName and then rename to InTouch.

TFS-1374842

InTouch HMI does not launch when Insight Publisher is uninstalled from System Platform 2020 R2.

Workaround: It is recommended not to uninstall Insight Publisher. However if Insight Publisher must be uninstalled, add ‘C:\Program Files(x86)\CommonFiles\ArchestrA’ to the Path environment variable after uninstallation, to allow InTouch HMI to launch correctly.

TFS-1377672

Connecting many clients to a busy OPC UA server may cause various warnings and errors to be logged from the InTouch OPCUA Host process. Warning messages are for information purposes only and do not indicate any loss in functionality. Error message indicate that the operation was aborted.

Workaround: It is recommended that client connections to the server be planned and monitored, so not to burden the server and cause connection failures.

InTouch HMI Documentation Issues

The following table lists corrections to InTouch HMI 2020 R2 documentation.

Item

Location of Change

Existing Documentation

Change

CR-L00157875

aaTrendClient.pdf

N/A

The following paragraph was included in the 'Scripting the Trend Client' section:

A Trend Client placed in a frame window supports panning and zooming. For more information on how to configure the ZoomPercent property, refer to the InTouch HMI Application Management and Extension Guide.

CR-L00157935

aaAlarmClientControl.pdf

N/A

The following note was included in the 'Showing Historical Alarms and/or Events section:

Note: For History Blocks, select Windows Integrated or Windows Account as the authentication mode.

CR-L00158413

ITApManagement.pdf

Starting the ArchestrA IDE from the Application Manager

The topic was removed from the guide.

CR-L00158745

ITAppManagement.pdf

N/A

The following sentence was added to the 'Managing Consumption of a Different License After Startup' section:

As part of standard upgrade and maintenance activities, different licenses can be deactivated or activated on the License Manager.

CR-L00159200

ITAppManagement.pdf

N/A

The following sentence was added to the 'Running WindowViewer as a Service' section:

If you configure WindowViewer to run as a Windows service, WindowViewer automatically starts when the computer on which the application is installed starts. The WindowViewer service runs in the background. If the WindowViewer service is running you cannot start another instance of WindowViewer.

CR-L00159373

ITAppManagement.pdf

N/A

The correct language file was updated in the product.

CR-L00158737

aaTrendClientControl.pdf

N/A

The following note was included in the 'Setting Chart Options' section:

Note: Optimal performance for the Trend Client can be observed when, the default values for Refresh Interval is set at 1 second and Refresh entire chart every is set at 100 intervals. The Trend Client is refreshed as a combination of both values and if the refresh rate is faster than the rate at which data is retrieved, data may not be plotted correctly.

InTouch Documentation

The InTouch product library consists of a set of Portable Document Files (PDF) available in the following location of the System Platform DVD:

\AVEVA System Platform\InstallFiles\CD-Intouch\UserDocs\English

You need Adobe Reader installed on your computer to view InTouch documentation. You can download the latest version of Adobe Reader from the Adobe Corporation web site:

http://www.adobe.com/products/acrobat/readstep2.html

After installing Adobe Reader, double-click a PDF file with your pointing device to view the book with Adobe Reader. You can also open a book with the Adobe Reader Open command from the File menu. Context-sensitive documentation is also available with InTouch online help. Select Help for information about the current InTouch window that you have open on your computer.

© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.   |   Contact Us